Skip to main content

VisitQueryResponse

Description

The response to a Visit Query is an array of patients, demographics, and visit details.

API endpoints for Visit Query Response

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/patient-admin/visit-Query-response.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Data Model JSON for VisitQueryResponse

VisitQueryResponse - Sample Payload
{
"Meta": {
"DataModel": "PatientAdmin",
"EventType": "VisitQueryResponse",
"EventDateTime": "2022-08-16T14:21:20.733Z",
"Test": true,
"Source": {
"ID": "3be3bccc-a827-4be1-bfd0-e07096b6b722",
"Name": "EHR Bridge Dev Tools"
},
"Destinations": [
{
"ID": "848009fd-4c92-4a91-9575-3596724fbec4",
"Name": "Destinations EMR"
}
],
"Logs": [
{
"ID": "c73905b4-2558-4929-a225-8277032657a6",
"AttemptID": "7fd40081-c20d-48f9-8520-55d44a3aeee1"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patients": [
{
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "0f445d2b-206b-4d01-9aa7-9a53d856f94e ",
"IDType": "EHRID"
},
{
"ID": "f1c0af61-7659-46f9-aa19-5a2a6830c94d ",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "John",
"MiddleName": "Henry",
"LastName": "Franklin",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088565301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 High Street",
"City": "San Jose"",
"State": "CA",
"ZIP": "53566",
"County": "Santa Clara",
"Country": "USA"
}
},
"Visits": [
{
"VisitNumber": "1234",
"VisitDateTime": "2022-08-16T14:21:21.528Z",
"PatientClass": "Inpatient",
"Location": {
"Type": "Inpatient",
"Facility": "KEM Hospital",
"Department": "3N",
"Room": "136",
"Bed": "B"
},
"Reason": "Check up",
"Status": "Arrived"
}
]
}
]
}